GUI for consistency check #12433

priyanshu16095 · 2025-01-30T21:29:57Z

Fixes #11950

This PR introduces a GUI for a bibliography consistency check to ensure consistency among BibTeX entries.

Mandatory checks

I own the copyright of the code submitted and I licence it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

github-actions

JUnit tests are failing. In the area "Some checks were not successful", locate "Tests / Unit tests (pull_request)" and click on "Details". This brings you to the test output.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

priyanshu16095 · 2025-01-30T21:40:47Z

Recording.2025-01-31.mp4

Added a table, but figuring out how to proceed with inserting data into the table as shown in the UI.

Please review.

github-actions

JUnit tests are failing. In the area "Some checks were not successful", locate "Tests / Unit tests (pull_request)" and click on "Details". This brings you to the test output.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

…95/jabref into consistencyGuiCheck

calixtus

Just by a quick look two remarks
Also about the picture in the issue: The user needs some hints what o and ? and so on mean. It must be understandable somehow right away.

src/main/java/org/jabref/logic/quality/consistency/ConsistencyMessage.java

src/main/java/org/jabref/gui/consistency/ConsistencyCheckDialog.java

src/main/java/org/jabref/gui/consistency/ConsistencyCheckAction.java

src/main/java/org/jabref/gui/consistency/ConsistencyCheckDialog.java

src/main/resources/l10n/JabRef_en.properties

src/main/java/org/jabref/gui/consistency/ConsistencyCheckDialogViewModel.java

src/main/java/org/jabref/gui/consistency/ConsistencyCheckDialog.java

src/main/java/org/jabref/gui/consistency/ConsistencyCheckAction.java

github-actions

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

In case of issues with the import order, double check that you activated Auto Import.
You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

CHANGELOG.md

Co-authored-by: Houssem Nasri <[email protected]>

…95/jabref into consistencyGuiCheck

priyanshu16095 · 2025-02-02T23:08:45Z

I have taken a lot of code as it is from the BibliographyConsistencyCheckResultWriter class in the ConsistencyCheckDialogViewModel class. Is there a better way to do this?

priyanshu16095 · 2025-02-03T07:07:04Z

Recording.2025-02-03.mp4

The table is displaying data correctly.
The tasks are running in background.

What remains to be done:

Providing information of the symbols.
Filtering data based on the selected value of the combo box
Implementing the jump to the selected row feature

Siedlerchr · 2025-02-09T18:20:31Z

The icon description is wrong, it should be:


x | required field is present
o | optional field is present
? | unknown field is present
- | field is absent

This is also modeled in

jabref/src/main/java/org/jabref/logic/quality/consistency/BibliographyConsistencyCheckResultWriter.java

Lines 43 to 46 in 13870d8

    
           protected static final String REQUIRED_FIELD_AT_ENTRY_TYPE_CELL_ENTRY = "x"; 
        
           protected static final String OPTIONAL_FIELD_AT_ENTRY_TYPE_CELL_ENTRY = "o"; 
        
           protected static final String UNKNOWN_FIELD_AT_ENTRY_TYPE_CELL_ENTRY = "?"; 
        
           protected static final String UNSET_FIELD_AT_ENTRY_TYPE_CELL_ENTRY = "-";

But the description here says otherwise:

priyanshu16095 · 2025-02-09T19:45:54Z

Oh! totally overlooked it. I have checked other places, and it is correct.

src/main/java/org/jabref/logic/importer/WebFetchers.java

calixtus · 2025-02-09T21:58:35Z

Either i dont understand one comment or its an artifact from another pr?

calixtus · 2025-02-09T21:59:13Z

Everything else looks good to go. Thanks for your great addition!

fixed

priyanshu16095 · 2025-02-11T13:17:50Z

src/main/java/org/jabref/logic/quality/consistency/ConsistencyMessage.java

+    @Override
+    public String toString() {
+        return "[" + message() + "]";
+    }


This is redundant here, as records provide a built-in toString method.

The purpose of this method elsewhere in the codebase is when multiple fields are required, like "[ " + bibEntry.getCitationKey() + ", " + message.toString() + " ]". However, the message field itself already includes the citationKey.

jabref/src/main/java/org/jabref/logic/integrity/IntegrityMessage.java

Lines 11 to 14 in 39d7971

@Override

public String toString() {

return "[" + entry().getCitationKey().orElse(entry().getAuthorTitleYear(50)) + "] in " + field.getDisplayName() + ": " + message();

}

In the follow up PR, should I also remove this.

koppor · 2025-02-17T11:13:24Z

@priyanshu16095 Thank you for the work on this - would you feel comfortable to write a blog entry for this? (JabRef/blog.jabref.org#108) - I think, you have enough domain knowledge to explain?

In your screenshot, I saw that there is the column "Pages" filled with "O". That should not happen - if everything is the same (presence), then there should be no output - or is the logic different.

Finally, the logic of the consistency check maybe should ignore JabRef's fields (ranking in your example). That can be a follow-up. Maybe even configurable during the check itself?

priyanshu16095 · 2025-02-17T14:56:11Z

Sure! I'd be happy to write a blog entry for this.

I'll check why the "Pages" column is showing "o" and adjust the logic if needed.

Ignoring JabRef-specific fields in the consistency check sounds like a good idea. I'll definitely try it in a follow-up.

koppor · 2025-02-17T17:16:13Z

Sure! I'd be happy to write a blog entry for this.

Nice! In parallel, I would ask for a text for https://github.com/JabRef/user-documentation. I think, there is an overlap of 80% 😅 (Which is OK!). The blog won't evolve later, but the user documention 😅

priyanshu16095 · 2025-02-18T00:18:19Z

Understood! I’ll ensure the core content fits both needs.

priyanshu16095 added 4 commits January 27, 2025 11:03

Create simple table UI

7d7a7f8

Add combox for entry type

77150ba

Add a CHANGELOG.md entry

46efae8

Merge branch 'main' into consistencyGuiCheck

31fe861

github-actions bot reviewed Jan 30, 2025

View reviewed changes

priyanshu16095 added 2 commits January 31, 2025 03:22

Correct a typo in JabRef_en.properties

09723ce

Merge branch 'consistencyGuiCheck' of https://github.com/priyanshu160…

9df0562

…95/jabref into consistencyGuiCheck

calixtus requested changes Jan 31, 2025

View reviewed changes

src/main/java/org/jabref/logic/quality/consistency/ConsistencyMessage.java Outdated Show resolved Hide resolved

src/main/java/org/jabref/gui/consistency/ConsistencyCheckDialog.java Outdated Show resolved Hide resolved

Make use of view model class

3b250f1